<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (c) 2004-2011 QOS.ch<a name="line.2"></a>
<span class="sourceLineNo">003</span> * All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * Permission is hereby granted, free  of charge, to any person obtaining<a name="line.5"></a>
<span class="sourceLineNo">006</span> * a  copy  of this  software  and  associated  documentation files  (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "Software"), to  deal in  the Software without  restriction, including<a name="line.7"></a>
<span class="sourceLineNo">008</span> * without limitation  the rights to  use, copy, modify,  merge, publish,<a name="line.8"></a>
<span class="sourceLineNo">009</span> * distribute,  sublicense, and/or sell  copies of  the Software,  and to<a name="line.9"></a>
<span class="sourceLineNo">010</span> * permit persons to whom the Software  is furnished to do so, subject to<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the following conditions:<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * The  above  copyright  notice  and  this permission  notice  shall  be<a name="line.13"></a>
<span class="sourceLineNo">014</span> * included in all copies or substantial portions of the Software.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,<a name="line.16"></a>
<span class="sourceLineNo">017</span> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF<a name="line.17"></a>
<span class="sourceLineNo">018</span> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND<a name="line.18"></a>
<span class="sourceLineNo">019</span> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<a name="line.19"></a>
<span class="sourceLineNo">020</span> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<a name="line.20"></a>
<span class="sourceLineNo">021</span> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION<a name="line.21"></a>
<span class="sourceLineNo">022</span> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>package org.slf4j;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.io.IOException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.net.URL;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.ArrayList;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Arrays;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Enumeration;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.LinkedHashSet;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.List;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.Set;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.concurrent.LinkedBlockingQueue;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.event.SubstituteLoggingEvent;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.helpers.NOPLoggerFactory;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.helpers.SubstituteLogger;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.slf4j.helpers.SubstituteLoggerFactory;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.slf4j.helpers.Util;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.slf4j.impl.StaticLoggerBinder;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * The &lt;code&gt;LoggerFactory&lt;/code&gt; is a utility class producing Loggers for<a name="line.45"></a>
<span class="sourceLineNo">046</span> * various logging APIs, most notably for log4j, logback and JDK 1.4 logging.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Other implementations such as {@link org.slf4j.impl.NOPLogger NOPLogger} and<a name="line.47"></a>
<span class="sourceLineNo">048</span> * {@link org.slf4j.impl.SimpleLogger SimpleLogger} are also supported.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p/&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;p/&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;code&gt;LoggerFactory&lt;/code&gt; is essentially a wrapper around an<a name="line.51"></a>
<span class="sourceLineNo">052</span> * {@link ILoggerFactory} instance bound with &lt;code&gt;LoggerFactory&lt;/code&gt; at<a name="line.52"></a>
<span class="sourceLineNo">053</span> * compile time.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;p/&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;p/&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Please note that all methods in &lt;code&gt;LoggerFactory&lt;/code&gt; are static.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * <a name="line.57"></a>
<span class="sourceLineNo">058</span> * <a name="line.58"></a>
<span class="sourceLineNo">059</span> * @author Alexander Dorokhine<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @author Robert Elliot<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @author Ceki G&amp;uuml;lc&amp;uuml;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * <a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span>public final class LoggerFactory {<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    static final String CODES_PREFIX = "http://www.slf4j.org/codes.html";<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    static final String NO_STATICLOGGERBINDER_URL = CODES_PREFIX + "#StaticLoggerBinder";<a name="line.68"></a>
<span class="sourceLineNo">069</span>    static final String MULTIPLE_BINDINGS_URL = CODES_PREFIX + "#multiple_bindings";<a name="line.69"></a>
<span class="sourceLineNo">070</span>    static final String NULL_LF_URL = CODES_PREFIX + "#null_LF";<a name="line.70"></a>
<span class="sourceLineNo">071</span>    static final String VERSION_MISMATCH = CODES_PREFIX + "#version_mismatch";<a name="line.71"></a>
<span class="sourceLineNo">072</span>    static final String SUBSTITUTE_LOGGER_URL = CODES_PREFIX + "#substituteLogger";<a name="line.72"></a>
<span class="sourceLineNo">073</span>    static final String LOGGER_NAME_MISMATCH_URL = CODES_PREFIX + "#loggerNameMismatch";<a name="line.73"></a>
<span class="sourceLineNo">074</span>    static final String REPLAY_URL = CODES_PREFIX + "#replay";<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    static final String UNSUCCESSFUL_INIT_URL = CODES_PREFIX + "#unsuccessfulInit";<a name="line.76"></a>
<span class="sourceLineNo">077</span>    static final String UNSUCCESSFUL_INIT_MSG = "org.slf4j.LoggerFactory in failed state. Original exception was thrown EARLIER. See also " + UNSUCCESSFUL_INIT_URL;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    static final int UNINITIALIZED = 0;<a name="line.79"></a>
<span class="sourceLineNo">080</span>    static final int ONGOING_INITIALIZATION = 1;<a name="line.80"></a>
<span class="sourceLineNo">081</span>    static final int FAILED_INITIALIZATION = 2;<a name="line.81"></a>
<span class="sourceLineNo">082</span>    static final int SUCCESSFUL_INITIALIZATION = 3;<a name="line.82"></a>
<span class="sourceLineNo">083</span>    static final int NOP_FALLBACK_INITIALIZATION = 4;<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    static volatile int INITIALIZATION_STATE = UNINITIALIZED;<a name="line.85"></a>
<span class="sourceLineNo">086</span>    static final SubstituteLoggerFactory SUBST_FACTORY = new SubstituteLoggerFactory();<a name="line.86"></a>
<span class="sourceLineNo">087</span>    static final NOPLoggerFactory NOP_FALLBACK_FACTORY = new NOPLoggerFactory();<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    // Support for detecting mismatched logger names.<a name="line.89"></a>
<span class="sourceLineNo">090</span>    static final String DETECT_LOGGER_NAME_MISMATCH_PROPERTY = "slf4j.detectLoggerNameMismatch";<a name="line.90"></a>
<span class="sourceLineNo">091</span>    static final String JAVA_VENDOR_PROPERTY = "java.vendor.url";<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span>    static boolean DETECT_LOGGER_NAME_MISMATCH = Util.safeGetBooleanSystemProperty(DETECT_LOGGER_NAME_MISMATCH_PROPERTY);<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>    /**<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * It is LoggerFactory's responsibility to track version changes and manage<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * the compatibility list.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * &lt;p/&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * &lt;p/&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * It is assumed that all versions in the 1.6 are mutually compatible.<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    static private final String[] API_COMPATIBILITY_LIST = new String[] { "1.6", "1.7" };<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    // private constructor prevents instantiation<a name="line.104"></a>
<span class="sourceLineNo">105</span>    private LoggerFactory() {<a name="line.105"></a>
<span class="sourceLineNo">106</span>    }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Force LoggerFactory to consider itself uninitialized.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * &lt;p/&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * &lt;p/&gt;<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * This method is intended to be called by classes (in the same package) for<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * testing purposes. This method is internal. It can be modified, renamed or<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * removed at any time without notice.<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * &lt;p/&gt;<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * &lt;p/&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * You are strongly discouraged from calling this method in production code.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     */<a name="line.118"></a>
<span class="sourceLineNo">119</span>    static void reset() {<a name="line.119"></a>
<span class="sourceLineNo">120</span>        INITIALIZATION_STATE = UNINITIALIZED;<a name="line.120"></a>
<span class="sourceLineNo">121</span>    }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>    private final static void performInitialization() {<a name="line.123"></a>
<span class="sourceLineNo">124</span>        bind();<a name="line.124"></a>
<span class="sourceLineNo">125</span>        if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>            versionSanityCheck();<a name="line.126"></a>
<span class="sourceLineNo">127</span>        }<a name="line.127"></a>
<span class="sourceLineNo">128</span>    }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>    private static boolean messageContainsOrgSlf4jImplStaticLoggerBinder(String msg) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        if (msg == null)<a name="line.131"></a>
<span class="sourceLineNo">132</span>            return false;<a name="line.132"></a>
<span class="sourceLineNo">133</span>        if (msg.contains("org/slf4j/impl/StaticLoggerBinder"))<a name="line.133"></a>
<span class="sourceLineNo">134</span>            return true;<a name="line.134"></a>
<span class="sourceLineNo">135</span>        if (msg.contains("org.slf4j.impl.StaticLoggerBinder"))<a name="line.135"></a>
<span class="sourceLineNo">136</span>            return true;<a name="line.136"></a>
<span class="sourceLineNo">137</span>        return false;<a name="line.137"></a>
<span class="sourceLineNo">138</span>    }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>    private final static void bind() {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        try {<a name="line.141"></a>
<span class="sourceLineNo">142</span>            Set&lt;URL&gt; staticLoggerBinderPathSet = null;<a name="line.142"></a>
<span class="sourceLineNo">143</span>            // skip check under android, see also<a name="line.143"></a>
<span class="sourceLineNo">144</span>            // http://jira.qos.ch/browse/SLF4J-328<a name="line.144"></a>
<span class="sourceLineNo">145</span>            if (!isAndroid()) {<a name="line.145"></a>
<span class="sourceLineNo">146</span>                staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();<a name="line.146"></a>
<span class="sourceLineNo">147</span>                reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);<a name="line.147"></a>
<span class="sourceLineNo">148</span>            }<a name="line.148"></a>
<span class="sourceLineNo">149</span>            // the next line does the binding<a name="line.149"></a>
<span class="sourceLineNo">150</span>            StaticLoggerBinder.getSingleton();<a name="line.150"></a>
<span class="sourceLineNo">151</span>            INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;<a name="line.151"></a>
<span class="sourceLineNo">152</span>            reportActualBinding(staticLoggerBinderPathSet);<a name="line.152"></a>
<span class="sourceLineNo">153</span>            fixSubstituteLoggers();<a name="line.153"></a>
<span class="sourceLineNo">154</span>            replayEvents();<a name="line.154"></a>
<span class="sourceLineNo">155</span>            // release all resources in SUBST_FACTORY<a name="line.155"></a>
<span class="sourceLineNo">156</span>            SUBST_FACTORY.clear();<a name="line.156"></a>
<span class="sourceLineNo">157</span>        } catch (NoClassDefFoundError ncde) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>            String msg = ncde.getMessage();<a name="line.158"></a>
<span class="sourceLineNo">159</span>            if (messageContainsOrgSlf4jImplStaticLoggerBinder(msg)) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>                INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;<a name="line.160"></a>
<span class="sourceLineNo">161</span>                Util.report("Failed to load class \"org.slf4j.impl.StaticLoggerBinder\".");<a name="line.161"></a>
<span class="sourceLineNo">162</span>                Util.report("Defaulting to no-operation (NOP) logger implementation");<a name="line.162"></a>
<span class="sourceLineNo">163</span>                Util.report("See " + NO_STATICLOGGERBINDER_URL + " for further details.");<a name="line.163"></a>
<span class="sourceLineNo">164</span>            } else {<a name="line.164"></a>
<span class="sourceLineNo">165</span>                failedBinding(ncde);<a name="line.165"></a>
<span class="sourceLineNo">166</span>                throw ncde;<a name="line.166"></a>
<span class="sourceLineNo">167</span>            }<a name="line.167"></a>
<span class="sourceLineNo">168</span>        } catch (java.lang.NoSuchMethodError nsme) {<a name="line.168"></a>
<span class="sourceLineNo">169</span>            String msg = nsme.getMessage();<a name="line.169"></a>
<span class="sourceLineNo">170</span>            if (msg != null &amp;&amp; msg.contains("org.slf4j.impl.StaticLoggerBinder.getSingleton()")) {<a name="line.170"></a>
<span class="sourceLineNo">171</span>                INITIALIZATION_STATE = FAILED_INITIALIZATION;<a name="line.171"></a>
<span class="sourceLineNo">172</span>                Util.report("slf4j-api 1.6.x (or later) is incompatible with this binding.");<a name="line.172"></a>
<span class="sourceLineNo">173</span>                Util.report("Your binding is version 1.5.5 or earlier.");<a name="line.173"></a>
<span class="sourceLineNo">174</span>                Util.report("Upgrade your binding to version 1.6.x.");<a name="line.174"></a>
<span class="sourceLineNo">175</span>            }<a name="line.175"></a>
<span class="sourceLineNo">176</span>            throw nsme;<a name="line.176"></a>
<span class="sourceLineNo">177</span>        } catch (Exception e) {<a name="line.177"></a>
<span class="sourceLineNo">178</span>            failedBinding(e);<a name="line.178"></a>
<span class="sourceLineNo">179</span>            throw new IllegalStateException("Unexpected initialization failure", e);<a name="line.179"></a>
<span class="sourceLineNo">180</span>        }<a name="line.180"></a>
<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span>    private static void fixSubstituteLoggers() {<a name="line.183"></a>
<span class="sourceLineNo">184</span>        synchronized (SUBST_FACTORY) {<a name="line.184"></a>
<span class="sourceLineNo">185</span>            SUBST_FACTORY.postInitialization();<a name="line.185"></a>
<span class="sourceLineNo">186</span>            for (SubstituteLogger substLogger : SUBST_FACTORY.getLoggers()) {<a name="line.186"></a>
<span class="sourceLineNo">187</span>                Logger logger = getLogger(substLogger.getName());<a name="line.187"></a>
<span class="sourceLineNo">188</span>                substLogger.setDelegate(logger);<a name="line.188"></a>
<span class="sourceLineNo">189</span>            }<a name="line.189"></a>
<span class="sourceLineNo">190</span>        }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span>    }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span>    static void failedBinding(Throwable t) {<a name="line.194"></a>
<span class="sourceLineNo">195</span>        INITIALIZATION_STATE = FAILED_INITIALIZATION;<a name="line.195"></a>
<span class="sourceLineNo">196</span>        Util.report("Failed to instantiate SLF4J LoggerFactory", t);<a name="line.196"></a>
<span class="sourceLineNo">197</span>    }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span>    private static void replayEvents() {<a name="line.199"></a>
<span class="sourceLineNo">200</span>        final LinkedBlockingQueue&lt;SubstituteLoggingEvent&gt; queue = SUBST_FACTORY.getEventQueue();<a name="line.200"></a>
<span class="sourceLineNo">201</span>        final int queueSize = queue.size();<a name="line.201"></a>
<span class="sourceLineNo">202</span>        int count = 0;<a name="line.202"></a>
<span class="sourceLineNo">203</span>        final int maxDrain = 128;<a name="line.203"></a>
<span class="sourceLineNo">204</span>        List&lt;SubstituteLoggingEvent&gt; eventList = new ArrayList&lt;SubstituteLoggingEvent&gt;(maxDrain);<a name="line.204"></a>
<span class="sourceLineNo">205</span>        while (true) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>            int numDrained = queue.drainTo(eventList, maxDrain);<a name="line.206"></a>
<span class="sourceLineNo">207</span>            if (numDrained == 0)<a name="line.207"></a>
<span class="sourceLineNo">208</span>                break;<a name="line.208"></a>
<span class="sourceLineNo">209</span>            for (SubstituteLoggingEvent event : eventList) {<a name="line.209"></a>
<span class="sourceLineNo">210</span>                replaySingleEvent(event);<a name="line.210"></a>
<span class="sourceLineNo">211</span>                if (count++ == 0)<a name="line.211"></a>
<span class="sourceLineNo">212</span>                    emitReplayOrSubstituionWarning(event, queueSize);<a name="line.212"></a>
<span class="sourceLineNo">213</span>            }<a name="line.213"></a>
<span class="sourceLineNo">214</span>            eventList.clear();<a name="line.214"></a>
<span class="sourceLineNo">215</span>        }<a name="line.215"></a>
<span class="sourceLineNo">216</span>    }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    private static void emitReplayOrSubstituionWarning(SubstituteLoggingEvent event, int queueSize) {<a name="line.218"></a>
<span class="sourceLineNo">219</span>        if (event.getLogger().isDelegateEventAware()) {<a name="line.219"></a>
<span class="sourceLineNo">220</span>            emitReplayWarning(queueSize);<a name="line.220"></a>
<span class="sourceLineNo">221</span>        } else if (event.getLogger().isDelegateNOP()) {<a name="line.221"></a>
<span class="sourceLineNo">222</span>            // nothing to do<a name="line.222"></a>
<span class="sourceLineNo">223</span>        } else {<a name="line.223"></a>
<span class="sourceLineNo">224</span>            emitSubstitutionWarning();<a name="line.224"></a>
<span class="sourceLineNo">225</span>        }<a name="line.225"></a>
<span class="sourceLineNo">226</span>    }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span>    private static void replaySingleEvent(SubstituteLoggingEvent event) {<a name="line.228"></a>
<span class="sourceLineNo">229</span>        if (event == null)<a name="line.229"></a>
<span class="sourceLineNo">230</span>            return;<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>        SubstituteLogger substLogger = event.getLogger();<a name="line.232"></a>
<span class="sourceLineNo">233</span>        String loggerName = substLogger.getName();<a name="line.233"></a>
<span class="sourceLineNo">234</span>        if (substLogger.isDelegateNull()) {<a name="line.234"></a>
<span class="sourceLineNo">235</span>            throw new IllegalStateException("Delegate logger cannot be null at this state.");<a name="line.235"></a>
<span class="sourceLineNo">236</span>        }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span>        if (substLogger.isDelegateNOP()) {<a name="line.238"></a>
<span class="sourceLineNo">239</span>            // nothing to do<a name="line.239"></a>
<span class="sourceLineNo">240</span>        } else if (substLogger.isDelegateEventAware()) {<a name="line.240"></a>
<span class="sourceLineNo">241</span>            substLogger.log(event);<a name="line.241"></a>
<span class="sourceLineNo">242</span>        } else {<a name="line.242"></a>
<span class="sourceLineNo">243</span>            Util.report(loggerName);<a name="line.243"></a>
<span class="sourceLineNo">244</span>        }<a name="line.244"></a>
<span class="sourceLineNo">245</span>    }<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span>    private static void emitSubstitutionWarning() {<a name="line.247"></a>
<span class="sourceLineNo">248</span>        Util.report("The following set of substitute loggers may have been accessed");<a name="line.248"></a>
<span class="sourceLineNo">249</span>        Util.report("during the initialization phase. Logging calls during this");<a name="line.249"></a>
<span class="sourceLineNo">250</span>        Util.report("phase were not honored. However, subsequent logging calls to these");<a name="line.250"></a>
<span class="sourceLineNo">251</span>        Util.report("loggers will work as normally expected.");<a name="line.251"></a>
<span class="sourceLineNo">252</span>        Util.report("See also " + SUBSTITUTE_LOGGER_URL);<a name="line.252"></a>
<span class="sourceLineNo">253</span>    }<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span>    private static void emitReplayWarning(int eventCount) {<a name="line.255"></a>
<span class="sourceLineNo">256</span>        Util.report("A number (" + eventCount + ") of logging calls during the initialization phase have been intercepted and are");<a name="line.256"></a>
<span class="sourceLineNo">257</span>        Util.report("now being replayed. These are subject to the filtering rules of the underlying logging system.");<a name="line.257"></a>
<span class="sourceLineNo">258</span>        Util.report("See also " + REPLAY_URL);<a name="line.258"></a>
<span class="sourceLineNo">259</span>    }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span>    private final static void versionSanityCheck() {<a name="line.261"></a>
<span class="sourceLineNo">262</span>        try {<a name="line.262"></a>
<span class="sourceLineNo">263</span>            String requested = StaticLoggerBinder.REQUESTED_API_VERSION;<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span>            boolean match = false;<a name="line.265"></a>
<span class="sourceLineNo">266</span>            for (String aAPI_COMPATIBILITY_LIST : API_COMPATIBILITY_LIST) {<a name="line.266"></a>
<span class="sourceLineNo">267</span>                if (requested.startsWith(aAPI_COMPATIBILITY_LIST)) {<a name="line.267"></a>
<span class="sourceLineNo">268</span>                    match = true;<a name="line.268"></a>
<span class="sourceLineNo">269</span>                }<a name="line.269"></a>
<span class="sourceLineNo">270</span>            }<a name="line.270"></a>
<span class="sourceLineNo">271</span>            if (!match) {<a name="line.271"></a>
<span class="sourceLineNo">272</span>                Util.report("The requested version " + requested + " by your slf4j binding is not compatible with "<a name="line.272"></a>
<span class="sourceLineNo">273</span>                                + Arrays.asList(API_COMPATIBILITY_LIST).toString());<a name="line.273"></a>
<span class="sourceLineNo">274</span>                Util.report("See " + VERSION_MISMATCH + " for further details.");<a name="line.274"></a>
<span class="sourceLineNo">275</span>            }<a name="line.275"></a>
<span class="sourceLineNo">276</span>        } catch (java.lang.NoSuchFieldError nsfe) {<a name="line.276"></a>
<span class="sourceLineNo">277</span>            // given our large user base and SLF4J's commitment to backward<a name="line.277"></a>
<span class="sourceLineNo">278</span>            // compatibility, we cannot cry here. Only for implementations<a name="line.278"></a>
<span class="sourceLineNo">279</span>            // which willingly declare a REQUESTED_API_VERSION field do we<a name="line.279"></a>
<span class="sourceLineNo">280</span>            // emit compatibility warnings.<a name="line.280"></a>
<span class="sourceLineNo">281</span>        } catch (Throwable e) {<a name="line.281"></a>
<span class="sourceLineNo">282</span>            // we should never reach here<a name="line.282"></a>
<span class="sourceLineNo">283</span>            Util.report("Unexpected problem occured during version sanity check", e);<a name="line.283"></a>
<span class="sourceLineNo">284</span>        }<a name="line.284"></a>
<span class="sourceLineNo">285</span>    }<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span>    // We need to use the name of the StaticLoggerBinder class, but we can't<a name="line.287"></a>
<span class="sourceLineNo">288</span>    // reference<a name="line.288"></a>
<span class="sourceLineNo">289</span>    // the class itself.<a name="line.289"></a>
<span class="sourceLineNo">290</span>    private static String STATIC_LOGGER_BINDER_PATH = "org/slf4j/impl/StaticLoggerBinder.class";<a name="line.290"></a>
<span class="sourceLineNo">291</span><a name="line.291"></a>
<span class="sourceLineNo">292</span>    static Set&lt;URL&gt; findPossibleStaticLoggerBinderPathSet() {<a name="line.292"></a>
<span class="sourceLineNo">293</span>        // use Set instead of list in order to deal with bug #138<a name="line.293"></a>
<span class="sourceLineNo">294</span>        // LinkedHashSet appropriate here because it preserves insertion order<a name="line.294"></a>
<span class="sourceLineNo">295</span>        // during iteration<a name="line.295"></a>
<span class="sourceLineNo">296</span>        Set&lt;URL&gt; staticLoggerBinderPathSet = new LinkedHashSet&lt;URL&gt;();<a name="line.296"></a>
<span class="sourceLineNo">297</span>        try {<a name="line.297"></a>
<span class="sourceLineNo">298</span>            ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();<a name="line.298"></a>
<span class="sourceLineNo">299</span>            Enumeration&lt;URL&gt; paths;<a name="line.299"></a>
<span class="sourceLineNo">300</span>            if (loggerFactoryClassLoader == null) {<a name="line.300"></a>
<span class="sourceLineNo">301</span>                paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);<a name="line.301"></a>
<span class="sourceLineNo">302</span>            } else {<a name="line.302"></a>
<span class="sourceLineNo">303</span>                paths = loggerFactoryClassLoader.getResources(STATIC_LOGGER_BINDER_PATH);<a name="line.303"></a>
<span class="sourceLineNo">304</span>            }<a name="line.304"></a>
<span class="sourceLineNo">305</span>            while (paths.hasMoreElements()) {<a name="line.305"></a>
<span class="sourceLineNo">306</span>                URL path = paths.nextElement();<a name="line.306"></a>
<span class="sourceLineNo">307</span>                staticLoggerBinderPathSet.add(path);<a name="line.307"></a>
<span class="sourceLineNo">308</span>            }<a name="line.308"></a>
<span class="sourceLineNo">309</span>        } catch (IOException ioe) {<a name="line.309"></a>
<span class="sourceLineNo">310</span>            Util.report("Error getting resources from path", ioe);<a name="line.310"></a>
<span class="sourceLineNo">311</span>        }<a name="line.311"></a>
<span class="sourceLineNo">312</span>        return staticLoggerBinderPathSet;<a name="line.312"></a>
<span class="sourceLineNo">313</span>    }<a name="line.313"></a>
<span class="sourceLineNo">314</span><a name="line.314"></a>
<span class="sourceLineNo">315</span>    private static boolean isAmbiguousStaticLoggerBinderPathSet(Set&lt;URL&gt; binderPathSet) {<a name="line.315"></a>
<span class="sourceLineNo">316</span>        return binderPathSet.size() &gt; 1;<a name="line.316"></a>
<span class="sourceLineNo">317</span>    }<a name="line.317"></a>
<span class="sourceLineNo">318</span><a name="line.318"></a>
<span class="sourceLineNo">319</span>    /**<a name="line.319"></a>
<span class="sourceLineNo">320</span>     * Prints a warning message on the console if multiple bindings were found<a name="line.320"></a>
<span class="sourceLineNo">321</span>     * on the class path. No reporting is done otherwise.<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * <a name="line.322"></a>
<span class="sourceLineNo">323</span>     */<a name="line.323"></a>
<span class="sourceLineNo">324</span>    private static void reportMultipleBindingAmbiguity(Set&lt;URL&gt; binderPathSet) {<a name="line.324"></a>
<span class="sourceLineNo">325</span>        if (isAmbiguousStaticLoggerBinderPathSet(binderPathSet)) {<a name="line.325"></a>
<span class="sourceLineNo">326</span>            Util.report("Class path contains multiple SLF4J bindings.");<a name="line.326"></a>
<span class="sourceLineNo">327</span>            for (URL path : binderPathSet) {<a name="line.327"></a>
<span class="sourceLineNo">328</span>                Util.report("Found binding in [" + path + "]");<a name="line.328"></a>
<span class="sourceLineNo">329</span>            }<a name="line.329"></a>
<span class="sourceLineNo">330</span>            Util.report("See " + MULTIPLE_BINDINGS_URL + " for an explanation.");<a name="line.330"></a>
<span class="sourceLineNo">331</span>        }<a name="line.331"></a>
<span class="sourceLineNo">332</span>    }<a name="line.332"></a>
<span class="sourceLineNo">333</span><a name="line.333"></a>
<span class="sourceLineNo">334</span>    private static boolean isAndroid() {<a name="line.334"></a>
<span class="sourceLineNo">335</span>        String vendor = Util.safeGetSystemProperty(JAVA_VENDOR_PROPERTY);<a name="line.335"></a>
<span class="sourceLineNo">336</span>        if (vendor == null)<a name="line.336"></a>
<span class="sourceLineNo">337</span>            return false;<a name="line.337"></a>
<span class="sourceLineNo">338</span>        return vendor.toLowerCase().contains("android");<a name="line.338"></a>
<span class="sourceLineNo">339</span>    }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span>    private static void reportActualBinding(Set&lt;URL&gt; binderPathSet) {<a name="line.341"></a>
<span class="sourceLineNo">342</span>        // binderPathSet can be null under Android<a name="line.342"></a>
<span class="sourceLineNo">343</span>        if (binderPathSet != null &amp;&amp; isAmbiguousStaticLoggerBinderPathSet(binderPathSet)) {<a name="line.343"></a>
<span class="sourceLineNo">344</span>            Util.report("Actual binding is of type [" + StaticLoggerBinder.getSingleton().getLoggerFactoryClassStr() + "]");<a name="line.344"></a>
<span class="sourceLineNo">345</span>        }<a name="line.345"></a>
<span class="sourceLineNo">346</span>    }<a name="line.346"></a>
<span class="sourceLineNo">347</span><a name="line.347"></a>
<span class="sourceLineNo">348</span>    /**<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * Return a logger named according to the name parameter using the<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * statically bound {@link ILoggerFactory} instance.<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * <a name="line.351"></a>
<span class="sourceLineNo">352</span>     * @param name<a name="line.352"></a>
<span class="sourceLineNo">353</span>     *            The name of the logger.<a name="line.353"></a>
<span class="sourceLineNo">354</span>     * @return logger<a name="line.354"></a>
<span class="sourceLineNo">355</span>     */<a name="line.355"></a>
<span class="sourceLineNo">356</span>    public static Logger getLogger(String name) {<a name="line.356"></a>
<span class="sourceLineNo">357</span>        ILoggerFactory iLoggerFactory = getILoggerFactory();<a name="line.357"></a>
<span class="sourceLineNo">358</span>        return iLoggerFactory.getLogger(name);<a name="line.358"></a>
<span class="sourceLineNo">359</span>    }<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span>    /**<a name="line.361"></a>
<span class="sourceLineNo">362</span>     * Return a logger named corresponding to the class passed as parameter,<a name="line.362"></a>
<span class="sourceLineNo">363</span>     * using the statically bound {@link ILoggerFactory} instance.<a name="line.363"></a>
<span class="sourceLineNo">364</span>     * <a name="line.364"></a>
<span class="sourceLineNo">365</span>     * &lt;p&gt;<a name="line.365"></a>
<span class="sourceLineNo">366</span>     * In case the the &lt;code&gt;clazz&lt;/code&gt; parameter differs from the name of the<a name="line.366"></a>
<span class="sourceLineNo">367</span>     * caller as computed internally by SLF4J, a logger name mismatch warning<a name="line.367"></a>
<span class="sourceLineNo">368</span>     * will be printed but only if the<a name="line.368"></a>
<span class="sourceLineNo">369</span>     * &lt;code&gt;slf4j.detectLoggerNameMismatch&lt;/code&gt; system property is set to<a name="line.369"></a>
<span class="sourceLineNo">370</span>     * true. By default, this property is not set and no warnings will be<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * printed even in case of a logger name mismatch.<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * <a name="line.372"></a>
<span class="sourceLineNo">373</span>     * @param clazz<a name="line.373"></a>
<span class="sourceLineNo">374</span>     *            the returned logger will be named after clazz<a name="line.374"></a>
<span class="sourceLineNo">375</span>     * @return logger<a name="line.375"></a>
<span class="sourceLineNo">376</span>     * <a name="line.376"></a>
<span class="sourceLineNo">377</span>     * <a name="line.377"></a>
<span class="sourceLineNo">378</span>     * @see &lt;a<a name="line.378"></a>
<span class="sourceLineNo">379</span>     *      href="http://www.slf4j.org/codes.html#loggerNameMismatch"&gt;Detected<a name="line.379"></a>
<span class="sourceLineNo">380</span>     *      logger name mismatch&lt;/a&gt;<a name="line.380"></a>
<span class="sourceLineNo">381</span>     */<a name="line.381"></a>
<span class="sourceLineNo">382</span>    public static Logger getLogger(Class&lt;?&gt; clazz) {<a name="line.382"></a>
<span class="sourceLineNo">383</span>        Logger logger = getLogger(clazz.getName());<a name="line.383"></a>
<span class="sourceLineNo">384</span>        if (DETECT_LOGGER_NAME_MISMATCH) {<a name="line.384"></a>
<span class="sourceLineNo">385</span>            Class&lt;?&gt; autoComputedCallingClass = Util.getCallingClass();<a name="line.385"></a>
<span class="sourceLineNo">386</span>            if (autoComputedCallingClass != null &amp;&amp; nonMatchingClasses(clazz, autoComputedCallingClass)) {<a name="line.386"></a>
<span class="sourceLineNo">387</span>                Util.report(String.format("Detected logger name mismatch. Given name: \"%s\"; computed name: \"%s\".", logger.getName(),<a name="line.387"></a>
<span class="sourceLineNo">388</span>                                autoComputedCallingClass.getName()));<a name="line.388"></a>
<span class="sourceLineNo">389</span>                Util.report("See " + LOGGER_NAME_MISMATCH_URL + " for an explanation");<a name="line.389"></a>
<span class="sourceLineNo">390</span>            }<a name="line.390"></a>
<span class="sourceLineNo">391</span>        }<a name="line.391"></a>
<span class="sourceLineNo">392</span>        return logger;<a name="line.392"></a>
<span class="sourceLineNo">393</span>    }<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span>    private static boolean nonMatchingClasses(Class&lt;?&gt; clazz, Class&lt;?&gt; autoComputedCallingClass) {<a name="line.395"></a>
<span class="sourceLineNo">396</span>        return !autoComputedCallingClass.isAssignableFrom(clazz);<a name="line.396"></a>
<span class="sourceLineNo">397</span>    }<a name="line.397"></a>
<span class="sourceLineNo">398</span><a name="line.398"></a>
<span class="sourceLineNo">399</span>    /**<a name="line.399"></a>
<span class="sourceLineNo">400</span>     * Return the {@link ILoggerFactory} instance in use.<a name="line.400"></a>
<span class="sourceLineNo">401</span>     * &lt;p/&gt;<a name="line.401"></a>
<span class="sourceLineNo">402</span>     * &lt;p/&gt;<a name="line.402"></a>
<span class="sourceLineNo">403</span>     * ILoggerFactory instance is bound with this class at compile time.<a name="line.403"></a>
<span class="sourceLineNo">404</span>     * <a name="line.404"></a>
<span class="sourceLineNo">405</span>     * @return the ILoggerFactory instance in use<a name="line.405"></a>
<span class="sourceLineNo">406</span>     */<a name="line.406"></a>
<span class="sourceLineNo">407</span>    public static ILoggerFactory getILoggerFactory() {<a name="line.407"></a>
<span class="sourceLineNo">408</span>        if (INITIALIZATION_STATE == UNINITIALIZED) {<a name="line.408"></a>
<span class="sourceLineNo">409</span>            synchronized (LoggerFactory.class) {<a name="line.409"></a>
<span class="sourceLineNo">410</span>                if (INITIALIZATION_STATE == UNINITIALIZED) {<a name="line.410"></a>
<span class="sourceLineNo">411</span>                    INITIALIZATION_STATE = ONGOING_INITIALIZATION;<a name="line.411"></a>
<span class="sourceLineNo">412</span>                    performInitialization();<a name="line.412"></a>
<span class="sourceLineNo">413</span>                }<a name="line.413"></a>
<span class="sourceLineNo">414</span>            }<a name="line.414"></a>
<span class="sourceLineNo">415</span>        }<a name="line.415"></a>
<span class="sourceLineNo">416</span>        switch (INITIALIZATION_STATE) {<a name="line.416"></a>
<span class="sourceLineNo">417</span>        case SUCCESSFUL_INITIALIZATION:<a name="line.417"></a>
<span class="sourceLineNo">418</span>            return StaticLoggerBinder.getSingleton().getLoggerFactory();<a name="line.418"></a>
<span class="sourceLineNo">419</span>        case NOP_FALLBACK_INITIALIZATION:<a name="line.419"></a>
<span class="sourceLineNo">420</span>            return NOP_FALLBACK_FACTORY;<a name="line.420"></a>
<span class="sourceLineNo">421</span>        case FAILED_INITIALIZATION:<a name="line.421"></a>
<span class="sourceLineNo">422</span>            throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG);<a name="line.422"></a>
<span class="sourceLineNo">423</span>        case ONGOING_INITIALIZATION:<a name="line.423"></a>
<span class="sourceLineNo">424</span>            // support re-entrant behavior.<a name="line.424"></a>
<span class="sourceLineNo">425</span>            // See also http://jira.qos.ch/browse/SLF4J-97<a name="line.425"></a>
<span class="sourceLineNo">426</span>            return SUBST_FACTORY;<a name="line.426"></a>
<span class="sourceLineNo">427</span>        }<a name="line.427"></a>
<span class="sourceLineNo">428</span>        throw new IllegalStateException("Unreachable code");<a name="line.428"></a>
<span class="sourceLineNo">429</span>    }<a name="line.429"></a>
<span class="sourceLineNo">430</span>}<a name="line.430"></a>




























































</pre>
</div>
</body>
</html>
